home *** CD-ROM | disk | FTP | other *** search
/ Multimedia Plus / Multimedia Plus with ClearVue Version 10-94 (Knowledge Media Inc.).ISO / extras / unarj.doc < prev    next >
Text File  |  1992-01-06  |  11KB  |  279 lines
  1.  
  2.      UNARJ.DOC, UNARJ 2.30                              January 1992
  3.  
  4.  
  5.         UNARJ software and manual copyright (c) 1991-92 by Robert K Jung.
  6.         All rights reserved.
  7.  
  8.         UNARJ version 2.30 release
  9.  
  10.  
  11.      This documents new or updated information since UNARJ 2.10.
  12.  
  13.  
  14.      ** IMPORTANT NEWS ****************************************************
  15.  
  16.      There is a newly defined flag bit in the ARJ flags.  See TECHNOTE.DOC
  17.      for details.  UNARJ only supports this flag bit with the "l" command.
  18.  
  19.      There is an extended header bug in older versions of ARJ, AV.C and
  20.      UNARJ.C.  The extended header processing in read_header() should skip
  21.      4 bytes for the extended header CRC and not 2 bytes.  This is NOT a
  22.      current problem as no versions of ARJ use the extended header.
  23.  
  24.      The following source line in DECODE.C is AMBIGUOUS and has been
  25.      corrected.
  26.  
  27.         weight[i++] = 1 << (16 - i);
  28.  
  29.      **********************************************************************
  30.  
  31.      Here is the C source code for a simple UNARJ extractor program.  It
  32.      has been portabilized courtesy of Mark Adler for platforms that do not
  33.      support ANSI C.  This UNARJ is NOT meant for use as a production
  34.      quality ARJ extractor.  It is meant for the use of 3rd party
  35.      developers who want to build file readers, etc, for ARJ.  The UNARJ
  36.      source code has been built and tested under Turbo C++ 1.0, Quick C
  37.      2.5, and Coherent 3.2.0.
  38.  
  39.      It has none of the program protection and other fancy features of
  40.      ARJ 2.30.  It is also VERY SLOW compared to ARJ!!!  In ARJ, all of
  41.      the critical routines are written in assembly language.
  42.  
  43.  
  44.      COMMAND SYNTAX:
  45.  
  46.      UNARJ has been modified to support the four commands: "e", "l", "t",
  47.      and "x".  These are similar to the ARJ version of these commands.
  48.      However, UNARJ does not create directories when using the "x" command.
  49.  
  50.      Usage:  UNARJ archive[.arj]    (list archive)
  51.              UNARJ e archive        (extract archive)
  52.              UNARJ l archive        (list archive)
  53.              UNARJ t archive        (test archive)
  54.              UNARJ x archive        (extract with pathnames)
  55.  
  56.      UNARJ does not accept any other commands or options.  You cannot
  57.      specify a base directory or select individual files to extract.  UNARJ
  58.      does not support empty directories or volume labels.  UNARJ is much
  59.      slower than ARJ because ARJ is highly optimized using assembly
  60.      language.
  61.  
  62.  
  63.      "e" extract command
  64.  
  65.      This command extracts the contents of the ARJ archive to the current
  66.      directory.  Files in the archive that already exist in the current
  67.      directory will not be extracted.
  68.  
  69.  
  70.      "l" list command
  71.  
  72.      This command lists the contents of the archive to the screen.  The
  73.      UNARJ l command replaces the old AV.EXE program.
  74.  
  75.      The last field on the display BTPMGVX stands for:
  76.          B -> file has been marked as a backup
  77.          T -> text/binary/directory/volume label type
  78.          P -> path information available in "V" listing
  79.          M -> compression method used
  80.          G -> file has been garbled (encrypted)
  81.          V -> archive has been continued to another volume
  82.          X -> this file is an extended portion of a larger file
  83.  
  84.  
  85.      "t" test command
  86.  
  87.      This command tests the contents of the archive by extracting the files
  88.      to the NUL device (no data will be written to disk).  If the contents
  89.      of a file is corrupted, UNARJ will display "CRC error!".  If the
  90.      contents are valid, UNARJ will display "CRC OK".
  91.  
  92.      You can use this command to see if an archive contains pathnames.
  93.  
  94.  
  95.      "x" extract with pathnames command
  96.  
  97.      This command extracts the contents of the ARJ archive to the pathnames
  98.      stored in the archive.  If only filespecs are stored in the archive,
  99.      then the files will be extracted to the current directory.  UNARJ will
  100.      not create missing directories in the pathnames.  You must create them
  101.      manually.  Use the UNARJ t command to see the full pathnames stored in
  102.      the archive.
  103.  
  104.  
  105.      PROGRESS INDICATOR
  106.  
  107.      UNARJ uses a small spinning bar to indicate extraction/testing
  108.      progress.  For some systems that have buffered output, the
  109.      progress indicator may not work.
  110.  
  111.  
  112.      BUILDING THE UNARJ PROGRAM
  113.  
  114.      Source files:  UNARJ.C, DECODE.C, ENVIRON.C, UNARJ.H, UNARJ.DEF,
  115.                     TCCUNARJ.MAK, QCLUNARJ.MAK, OS2UNARJ.MAK.
  116.  
  117.      For Turbo C/C++, type MAKE /ftccunarj.mak
  118.  
  119.      For QuickC,      type NMAKE /F qclunarj.mak
  120.  
  121.      For OS/2,        type NMAKE /F os2unarj.mak
  122.  
  123.      For Coherent,    type
  124.          cc -DUNIX -DCOHERENT -o unarj unarj.c decode.c environ.c
  125.  
  126.      For UNIX         type cc -DUNIX -o unarj unarj.c decode.c environ.c
  127.  
  128.      If you use a compiler other than listed above, the resulting UNARJ.EXE
  129.      will not support restoring file date-time stamps.  You can modify the
  130.      ENVIRON.C file to add these functions for your particular
  131.      implementation environment.
  132.  
  133.      If you send me your implementations, I will try to incorporate them
  134.      into the next version of UNARJ.
  135.  
  136.  
  137.      ACKNOWLEDGEMENTS:
  138.  
  139.      I wish to thank Haruhiko Okumura for providing the ideas for ARJ and
  140.      UNARJ.  His AR001 and AR002 provided the basic compression algorithms
  141.      for ARJ 1.0.  At ARJ 2.0, ARJ uses only the secondary Huffman
  142.      compressor from AR002.
  143.  
  144.      I wish to thank Mark Adler for helping make UNARJ more portable.
  145.  
  146.      I also wish to acknowledge the use of the file date-time stamping
  147.      routines in Rahul Dhesi's ZOO archiver.
  148.  
  149.      And to those who have contributed bug reports and porting
  150.      information, I extend my thanks.
  151.  
  152.  
  153.      UNARJ LICENSE POLICY FOR ALL USERS:
  154.  
  155.      The UNARJ program, source code, and the associated documentation
  156.      are copyright (c) 1990-92 Robert K Jung, all rights reserved.
  157.  
  158.      If you distribute this software to others, you are required to
  159.      distribute the ENTIRE package consisting of the following files:
  160.  
  161.      README.DOC
  162.      UNARJ.EXE
  163.      UNARJ.DOC
  164.      UNARJ.C
  165.      DECODE.C
  166.      ENVIRON.C
  167.      UNARJ.H
  168.      UNARJ.DEF
  169.      TCCUNARJ.MAK
  170.      QCLUNARJ.MAK
  171.      OS2UNARJ.MAK
  172.      TECHNOTE.DOC
  173.  
  174.      I strongly prefer that the files be distributed in the format
  175.      originally released:  UNARJ230.EXE with the ARJ-SECURITY envelope as
  176.      created by the author.  If you must distribute the UNARJ archive in
  177.      another archive format, please archive the UNARJ230.EXE as one file
  178.      inside the other archive.  Re-archival of the software as separate
  179.      files means losing the ARJ security envelope.
  180.  
  181.      You may freely use the UNARJ C source code provided the end product is
  182.      NOT an ARJ archiver (both compress and extract ARJ files).  If you
  183.      wish to distribute a modified version of UNARJ.EXE, you MUST indicate
  184.      that it is a modified version both in the program and source code.
  185.  
  186.      If you create a modified version of UNARJ.EXE, I would appreciate a
  187.      copy of the new source code.  I am holding the copyright on the source
  188.      code, so please do not delete my name from the program files or the
  189.      documentation.
  190.  
  191.      The UNARJ.EXE program is built from this source using Turbo C++ 1.0.
  192.  
  193.      You may freely use, copy, and distribute UNARJ.EXE, provided that no
  194.      fee is charged for such use, copying or distribution.
  195.  
  196.      You may use UNARJ.EXE in a commercial software package provided that
  197.      no additional fee is charged for using UNARJ.EXE and provided that the
  198.      user fully understands that NO warranty or support is provided for
  199.      UNARJ.EXE.  Moreover, the user must fully understand that UNARJ does
  200.      not have the long usage history as ARJ does.
  201.  
  202.      This source code is intended to promote the building of utilities to
  203.      support the use of ARJ and ARJ archives.
  204.  
  205.  
  206.      TECHNICAL SUPPORT:
  207.  
  208.      Please report any bugs.  I will TRY to fix them.  If you have
  209.      portability improvements, I would appreciate receiving a copy of them.
  210.  
  211.      If you find UNARJ of value, a gift of 10 dollars or any amount would be
  212.      greatly appreciated.
  213.  
  214.      I can be reached at:
  215.  
  216.      Robert Jung at Channel One BBS   (617) 354-8873
  217.  
  218.      Robert Jung at Bay State BBS     (617) 598-6646
  219.  
  220.      Robert Jung at FIDONET address:  1:16/390.7
  221.  
  222.      Robert Jung in the ARJ (RIME/RELAYNET), COMPRESS (ILINK), LHARC /
  223.      COMPRESSIONS (SMARTNET), or ARCHIVERS (RIME/RELAYNET) echo
  224.      conferences.
  225.  
  226.      2606 Village Road West
  227.      Norwood, Massachusetts 02062
  228.      USA
  229.  
  230.      Internet address:  robjung@world.std.com  (Checked daily)
  231.  
  232.      Compuserve users can enter   >INTERNET: robjung@world.std.com
  233.      at the "Send to" prompt.  I prefer CompuServe users to send mail
  234.      to this address as opposed to my CompuServe userid below.
  235.  
  236.      CompuServe userid: 72077,445  (Checked infrequently)
  237.  
  238.  
  239.      DISCLAIMER:
  240.  
  241.      This software UNARJ is provided on an "as is" basis without warranty
  242.      of any kind, expressed or implied, including but not limited to the
  243.      implied warranties of merchantability and fitness for a particular
  244.      purpose.  The person using the software bears all risk as to the
  245.      quality and performance of the software. Should the software prove
  246.      defective, the user assumes the entire cost of all necessary repair,
  247.      servicing, or correction.  The author will not be liable for any
  248.      special, incidental, consequential, indirect or similar damages due to
  249.      loss of data or any other reason, even if the author or an agent of
  250.      the author has been advised of the possibility of such damages.
  251.  
  252.  
  253.      HISTORY:
  254.  
  255.      UNARJ 2.30 - Added new header arj flag (BACKUP_FLAG).
  256.                   Updated information in TECHNOTE.DOC.
  257.  
  258.      UNARJ 2.22 - Added missing semicolon to unarj.c for THINK_C.
  259.                   Modified text mode processing to include test for
  260.                   host_os in fwrite_txt_crc().
  261.                   Added more error checking to unarj.c.
  262.  
  263.      UNARJ 2.21 - Changed uint ratio() to static uint ratio().
  264.                   Added #ifdef VMS to unarj.c.
  265.                   Tested unarj on COHERENT (UNIX clone).
  266.                   Fixed use of _chmod to handle directories.
  267.                   Modified unarj.c to support the MAC THINK_C compiler.
  268.                   Added #include <stdlib.h> to vanilla section of environ.c.
  269.                   Added file date-time stamping to UNIX section of environ.c.
  270.  
  271.      UNARJ 2.20 - Changed arguments in get_mode_str() and set_ftime_mode() to
  272.                   at least int size.
  273.  
  274.                   Added default_case_path() for convenience in UNIX.
  275.  
  276.                   Added two missing %c from printf statement in list_arc().
  277.  
  278.    end document
  279.